home *** CD-ROM | disk | FTP | other *** search
/ SGI Freeware 1999 August / SGI Freeware 1999 August.iso / dist / fw_audiofile.idb / usr / freeware / include / audiofile / audiofile.h.z / audiofile.h
Encoding:
C/C++ Source or Header  |  1999-07-16  |  23.1 KB  |  610 lines
  1. /*
  2.     Audio File Library
  3.     Copyright (C) 1998-1999, Michael Pruett <michael@68k.org>
  4.  
  5.     This library is free software; you can redistribute it and/or
  6.     modify it under the terms of the GNU Library General Public
  7.     License as published by the Free Software Foundation; either
  8.     version 2 of the License, or (at your option) any later version.
  9.  
  10.     This library is distributed in the hope that it will be useful,
  11.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  12.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  13.     Library General Public License for more details.
  14.  
  15.     You should have received a copy of the GNU Library General Public
  16.     License along with this library; if not, write to the 
  17.     Free Software Foundation, Inc., 59 Temple Place - Suite 330, 
  18.     Boston, MA  02111-1307  USA.
  19. */
  20.  
  21. /*
  22.     audiofile.h
  23.  
  24.     This file contains the public interfaces to the Audio File Library.
  25. */
  26.  
  27. #ifndef AUDIOFILE_H
  28. #define AUDIOFILE_H
  29.  
  30. #include <sys/types.h>
  31. #include "aupvlist.h"
  32.  
  33. #ifdef __cplusplus
  34. extern "C"
  35. {
  36. #endif /* __cplusplus */
  37.  
  38. typedef struct _AFfilesetup *AFfilesetup;
  39. typedef struct _AFfilehandle *AFfilehandle;
  40. typedef void (*AFerrfunc)(long, const char *);
  41.  
  42. typedef off_t AFframecount;
  43. typedef off_t AFfileoffset;
  44.  
  45. #define AF_NULL_FILESETUP    ((struct _AFfilesetup *) 0)
  46. #define AF_NULL_FILEHANDLE    ((struct _AFfilehandle *) 0)
  47.  
  48. #define AF_ERR_BASE 3000
  49.  
  50. enum
  51. {
  52.     AF_DEFAULT_TRACK = 1001
  53. };
  54.  
  55. enum
  56. {
  57.     AF_DEFAULT_INST = 2001
  58. };
  59.  
  60. enum
  61. {
  62.     AF_NUM_UNLIMITED = 99999
  63. };
  64.  
  65. enum
  66. {
  67.     AF_BYTEORDER_BIGENDIAN = 501,
  68.     AF_BYTEORDER_LITTLEENDIAN = 502
  69. };
  70.  
  71. enum
  72. {
  73.     AF_FILE_UNKNOWN = -1,
  74.     AF_FILE_RAWDATA = 0,
  75.     AF_FILE_AIFFC = 1,
  76.     AF_FILE_AIFF = 2,
  77.     AF_FILE_NEXTSND = 3,
  78.     AF_FILE_WAVE = 4,
  79.     AF_FILE_BICSF = 5,
  80.     AF_FILE_MPEG1BITSTREAM = 6,
  81.     AF_FILE_SOUNDDESIGNER1 = 7,
  82.     AF_FILE_SOUNDDESIGNER2 = 8,
  83.     AF_FILE_AVR = 9,
  84.     AF_FILE_IFF_8SVX = 10,
  85.     AF_FILE_SAMPLEVISION = 11,
  86.     AF_FILE_VOC = 12,
  87.     AF_FILE_NIST_SPHERE = 13,
  88.     AF_FILE_SOUNDFONT2 = 14
  89. };
  90.  
  91. #define AF_FILE_IRCAM AF_FILE_BICSF
  92.  
  93. enum
  94. {
  95.     AF_LOOP_MODE_NOLOOP = 0,
  96.     AF_LOOP_MODE_FORW = 1,
  97.     AF_LOOP_MODE_FORWBACKW = 2
  98. };
  99.  
  100. enum
  101. {
  102.     AF_SAMPFMT_TWOSCOMP = 401,
  103.     AF_SAMPFMT_UNSIGNED = 402,
  104.     AF_SAMPFMT_FLOAT = 403,
  105.     AF_SAMPFMT_DOUBLE = 404
  106. };
  107.  
  108. enum
  109. {
  110.     AF_INST_LOOP_OFF = 0,            /* no looping */
  111.     AF_INST_LOOP_CONTINUOUS = 1,    /* loop continuously through decay */
  112.     AF_INST_LOOP_SUSTAIN = 3        /* loop during sustain, then continue */
  113. };
  114.  
  115. enum
  116. {
  117.     AF_INST_MIDI_BASENOTE = 301,
  118.     AF_INST_NUMCENTS_DETUNE = 302,
  119.     AF_INST_MIDI_LONOTE = 303,
  120.     AF_INST_MIDI_HINOTE = 304,
  121.     AF_INST_MIDI_LOVELOCITY = 305,
  122.     AF_INST_MIDI_HIVELOCITY = 306,
  123.     AF_INST_NUMDBS_GAIN = 307,
  124.     AF_INST_SUSLOOPID = 308,        /* loop id for AIFF sustain loop */
  125.     AF_INST_RELLOOPID = 309,        /* loop id for AIFF release loop */
  126.     AF_INST_SAMP_STARTFRAME = 310,    /* start sample for this inst */
  127.     AF_INST_SAMP_ENDFRAME = 311,    /* end sample for this inst */
  128.     AF_INST_SAMP_MODE = 312,        /* looping mode for this inst */
  129.     AF_INST_TRACKID = 313,
  130.     AF_INST_NAME = 314,                /* name of this inst */
  131.     AF_INST_SAMP_RATE = 315,        /* sample rate of this inst's sample */
  132.     AF_INST_PRESETID = 316,            /* ID of preset containing this inst */
  133.     AF_INST_PRESET_NAME = 317        /* name of preset containing this inst */
  134. };
  135.  
  136. enum
  137. {
  138.     AF_MISC_UNRECOGNIZED = 0,    /* unrecognized data chunk */
  139.     AF_MISC_COPY = 201,    /* copyright string */
  140.     AF_MISC_AUTH = 202,    /* author string */
  141.     AF_MISC_NAME = 203,    /* name string */
  142.     AF_MISC_ANNO = 204,    /* annotation string */
  143.     AF_MISC_APPL = 205,    /* application-specific data */
  144.     AF_MISC_MIDI = 206,    /* MIDI exclusive data */
  145.     AF_MISC_PCMMAP = 207,    /* PCM mapping information (future use) */
  146.     AF_MISC_NeXT = 208,    /* misc binary data appended to NeXT hdr */
  147.     AF_MISC_IRCAM_PEAKAMP = 209,    /* peak amplitude information */
  148.     AF_MISC_IRCAM_COMMENT = 210,    /* BICSF text comment */
  149.     AF_MISC_COMMENT = 210,    /* general text comment */
  150.  
  151.     AF_MISC_ICMT = AF_MISC_COMMENT,    /* comments chunk (WAV format) */
  152.     AF_MISC_ICRD = 211,  /* creation date (WAV format) */
  153.     AF_MISC_ISFT = 212  /* software name (WAV format) */
  154. };
  155.  
  156. enum
  157. {
  158.     /* supported compression schemes */
  159.     AF_COMPRESSION_UNKNOWN = -1,
  160.     AF_COMPRESSION_NONE = 0,
  161.     AF_COMPRESSION_G722 = 501,
  162.     AF_COMPRESSION_G711_ULAW = 502,
  163.     AF_COMPRESSION_G711_ALAW = 503,
  164.  
  165.     /* Apple proprietary AIFF-C compression schemes (not supported) */
  166.     AF_COMPRESSION_APPLE_ACE2 = 504,
  167.     AF_COMPRESSION_APPLE_ACE8 = 505,
  168.     AF_COMPRESSION_APPLE_MAC3 = 506,
  169.     AF_COMPRESSION_APPLE_MAC6 = 507,
  170.  
  171.     AF_COMPRESSION_MPEG1 = 515,
  172.     AF_COMPRESSION_AWARE_MULTIRATE = 516,
  173.  
  174.     AF_COMPRESSION_G726 = 517,
  175.     AF_COMPRESSION_G728 = 518,
  176.     AF_COMPRESSION_DVI_AUDIO = 519,
  177.     AF_COMPRESSION_GSM = 520,
  178.     AF_COMPRESSION_FS1016 = 521,
  179.  
  180.     AF_COMPRESSION_DEFAULT_MPEG_I = 508,
  181.     AF_COMPRESSION_DEFAULT_MPEG1_LAYERI = AF_COMPRESSION_DEFAULT_MPEG_I,
  182.     AF_COMPRESSION_DEFAULT_MPEG_II = 509,
  183.     AF_COMPRESSION_DEFAULT_MPEG1_LAYERII = AF_COMPRESSION_DEFAULT_MPEG_II,
  184.     AF_COMPRESSION_DEFAULT_MULTIRATE = 513,
  185.     AF_COMPRESSION_DEFAULT_LOSSLESS = 514
  186. };
  187.  
  188. /* tokens for afQuery() -- see the man page for instructions */
  189. /* level 1 selectors */
  190. enum
  191. {
  192.     AF_QUERYTYPE_INSTPARAM = 500,
  193.     AF_QUERYTYPE_FILEFMT = 501,
  194.     AF_QUERYTYPE_COMPRESSION = 502,
  195.     AF_QUERYTYPE_COMPRESSIONPARAM = 503,
  196.     AF_QUERYTYPE_MISC = 504,
  197.     AF_QUERYTYPE_INST = 505,
  198.     AF_QUERYTYPE_MARK = 506,
  199.     AF_QUERYTYPE_LOOP = 507
  200. };
  201.  
  202. /* level 2 selectors */
  203. enum
  204. {
  205.     AF_QUERY_NAME = 600,    /* get name (1-3 words) */
  206.     AF_QUERY_DESC = 601,    /* get description */
  207.     AF_QUERY_LABEL = 602,    /* get 4- or 5-char label */
  208.     AF_QUERY_TYPE = 603,    /* get type token */
  209.     AF_QUERY_DEFAULT = 604,    /* dflt. value for param */
  210.     AF_QUERY_ID_COUNT = 605,    /* get number of ids avail. */
  211.     AF_QUERY_IDS = 606,    /* get array of id tokens */
  212.     AF_QUERY_IMPLEMENTED = 613,    /* boolean */
  213.     AF_QUERY_TYPE_COUNT = 607,    /* get number of types av. */
  214.     AF_QUERY_TYPES = 608,    /* get array of types */
  215.     AF_QUERY_NATIVE_SAMPFMT = 609,    /* for compression */
  216.     AF_QUERY_NATIVE_SAMPWIDTH = 610,
  217.     AF_QUERY_SQUISHFAC = 611,    /* 1.0 means variable */
  218.     AF_QUERY_MAX_NUMBER = 612,    /* max allowed in file */
  219.     AF_QUERY_SUPPORTED = 613    /* insts, loops, etc., supported? */
  220. };
  221.  
  222. /* level 2 selectors which have sub-selectors */
  223. enum
  224. {
  225.     AF_QUERY_TRACKS = 620,
  226.     AF_QUERY_CHANNELS = 621,
  227.     AF_QUERY_SAMPLE_SIZES = 622,
  228.     AF_QUERY_SAMPLE_FORMATS = 623,
  229.     AF_QUERY_COMPRESSION_TYPES = 624
  230. };
  231.  
  232. /* level 3 sub-selectors */
  233. enum
  234. {
  235.     AF_QUERY_VALUE_COUNT = 650,    /* number of values of the above */
  236.     AF_QUERY_VALUES = 651    /* array of those values */
  237. };
  238.  
  239.  
  240. /*
  241.     Old Audio File Library error codes. These are still returned by the
  242.     AFerrorhandler calls, but are not used by the new digital media library
  243.     error reporting routines. See the bottom of this file for the new error
  244.     tokens.
  245. */
  246.  
  247. enum
  248. {
  249.     AF_BAD_NOT_IMPLEMENTED = 0,    /* not implemented yet */
  250.     AF_BAD_FILEHANDLE = 1,    /* tried to use invalid filehandle */
  251.     AF_BAD_OPEN = 3,    /* unix open failed */
  252.     AF_BAD_CLOSE = 4,    /* unix close failed */
  253.     AF_BAD_READ = 5,    /* unix read failed */
  254.     AF_BAD_WRITE = 6,    /* unix write failed */
  255.     AF_BAD_LSEEK = 7,    /* unix lseek failed */
  256.     AF_BAD_NO_FILEHANDLE = 8,    /* failed to allocate a filehandle struct */
  257.     AF_BAD_ACCMODE = 10,    /* unrecognized audio file access mode */
  258.     AF_BAD_NOWRITEACC = 11,    /* file not open for writing */
  259.     AF_BAD_NOREADACC = 12,    /* file not open for reading */
  260.     AF_BAD_FILEFMT = 13,    /* unrecognized audio file format */
  261.     AF_BAD_RATE = 14,    /* invalid sample rate */
  262.     AF_BAD_CHANNELS = 15,    /* invalid number of channels*/
  263.     AF_BAD_SAMPCNT = 16,    /* invalid sample count */
  264.     AF_BAD_WIDTH = 17,    /* invalid sample width */
  265.     AF_BAD_SEEKMODE = 18,    /* invalid seek mode */
  266.     AF_BAD_NO_LOOPDATA = 19,    /* failed to allocate loop struct */
  267.     AF_BAD_MALLOC = 20,    /* malloc failed somewhere */
  268.     AF_BAD_LOOPID = 21,
  269.     AF_BAD_SAMPFMT = 22,    /* bad sample format */
  270.     AF_BAD_FILESETUP = 23,    /* bad file setup structure*/
  271.     AF_BAD_TRACKID = 24,    /* no track corresponding to id */
  272.     AF_BAD_NUMTRACKS = 25,    /* wrong number of tracks for file format */
  273.     AF_BAD_NO_FILESETUP = 26,    /* failed to allocate a filesetup struct*/
  274.     AF_BAD_LOOPMODE = 27,    /* unrecognized loop mode value */
  275.     AF_BAD_INSTID = 28,    /* invalid instrument id */
  276.     AF_BAD_NUMLOOPS = 29,    /* bad number of loops */
  277.     AF_BAD_NUMMARKS = 30,    /* bad number of markers */
  278.     AF_BAD_MARKID = 31,    /* bad marker id */
  279.     AF_BAD_MARKPOS = 32,    /* invalid marker position value */
  280.     AF_BAD_NUMINSTS = 33,    /* invalid number of instruments */
  281.     AF_BAD_NOAESDATA = 34,
  282.     AF_BAD_MISCID = 35,
  283.     AF_BAD_NUMMISC = 36,
  284.     AF_BAD_MISCSIZE = 37,
  285.     AF_BAD_MISCTYPE = 38,
  286.     AF_BAD_MISCSEEK = 39,
  287.     AF_BAD_STRLEN = 40,    /* invalid string length */
  288.     AF_BAD_RATECONV = 45,
  289.     AF_BAD_SYNCFILE = 46,
  290.     AF_BAD_CODEC_CONFIG = 47,    /* improperly configured codec */
  291.     AF_BAD_CODEC_STATE = 48,    /* invalid codec state: can't recover */
  292.     AF_BAD_CODEC_LICENSE = 49,    /* no license available for codec */
  293.     AF_BAD_CODEC_TYPE = 50,    /* unsupported codec type */
  294.     AF_BAD_COMPRESSION = AF_BAD_CODEC_CONFIG,    /* for back compat */
  295.     AF_BAD_COMPTYPE = AF_BAD_CODEC_TYPE,    /* for back compat */
  296.  
  297.     AF_BAD_INSTPTYPE = 51,    /* invalid instrument parameter type */
  298.     AF_BAD_INSTPID = 52,    /* invalid instrument parameter id */
  299.     AF_BAD_BYTEORDER = 53,
  300.     AF_BAD_FILEFMT_PARAM = 54,    /* unrecognized file format parameter */
  301.     AF_BAD_COMP_PARAM = 55,    /* unrecognized compression parameter */
  302.     AF_BAD_DATAOFFSET = 56,    /* bad data offset */
  303.     AF_BAD_FRAMECNT = 57,    /* bad frame count */
  304.     AF_BAD_QUERYTYPE = 58,    /* bad query type */
  305.     AF_BAD_QUERY = 59,    /* bad argument to afQuery() */
  306.     AF_WARNING_CODEC_RATE = 60,    /* using 8k instead of codec rate 8012 */
  307.     AF_WARNING_RATECVT = 61,    /* warning about rate conversion used */
  308.  
  309.     AF_BAD_HEADER = 62,    /* failed to parse header */
  310.     AF_BAD_FRAME = 63,    /* bad frame number */
  311.     AF_BAD_LOOPCOUNT = 64,    /* bad loop count */
  312.     AF_BAD_DMEDIA_CALL = 65,    /* error in dmedia subsystem call */
  313.  
  314.     /* AIFF/AIFF-C specific errors when parsing file header */
  315.     AF_BAD_AIFF_HEADER = 108,    /* failed to parse chunk header */
  316.     AF_BAD_AIFF_FORM = 109,    /* failed to parse FORM chunk */
  317.     AF_BAD_AIFF_SSND = 110,    /* failed to parse SSND chunk */
  318.     AF_BAD_AIFF_CHUNKID = 111,    /* unrecognized AIFF/AIFF-C chunk id */
  319.     AF_BAD_AIFF_COMM = 112,    /* failed to parse COMM chunk */
  320.     AF_BAD_AIFF_INST = 113,    /* failed to parse INST chunk */
  321.     AF_BAD_AIFF_MARK = 114,    /* failed to parse MARK chunk */
  322.     AF_BAD_AIFF_SKIP = 115,    /* failed to skip unsupported chunk */
  323.     AF_BAD_AIFF_LOOPMODE = 116    /* unrecognized loop mode (forw, etc)*/
  324. };
  325.  
  326. /* new error codes which may be retrieved via dmGetError() */
  327. /* The old error tokens continue to be retrievable via the AFerrorhandler */
  328. /* AF_ERR_BASE is #defined in dmedia/dmedia.h */
  329.  
  330. enum
  331. {
  332.     AF_ERR_NOT_IMPLEMENTED = 0+AF_ERR_BASE,    /* not implemented yet */
  333.     AF_ERR_BAD_FILEHANDLE = 1+AF_ERR_BASE,    /* invalid filehandle */
  334.     AF_ERR_BAD_READ = 5+AF_ERR_BASE,    /* unix read failed */
  335.     AF_ERR_BAD_WRITE = 6+AF_ERR_BASE,    /* unix write failed */
  336.     AF_ERR_BAD_LSEEK = 7+AF_ERR_BASE,    /* unix lseek failed */
  337.     AF_ERR_BAD_ACCMODE = 10+AF_ERR_BASE,    /* unrecognized audio file access mode */
  338.     AF_ERR_NO_WRITEACC = 11+AF_ERR_BASE,    /* file not open for writing */
  339.     AF_ERR_NO_READACC = 12+AF_ERR_BASE,    /* file not open for reading */
  340.     AF_ERR_BAD_FILEFMT = 13+AF_ERR_BASE,    /* unrecognized audio file format */
  341.     AF_ERR_BAD_RATE = 14+AF_ERR_BASE,    /* invalid sample rate */
  342.     AF_ERR_BAD_CHANNELS = 15+AF_ERR_BASE,    /* invalid # channels*/
  343.     AF_ERR_BAD_SAMPCNT = 16+AF_ERR_BASE,    /* invalid sample count */
  344.     AF_ERR_BAD_WIDTH = 17+AF_ERR_BASE,    /* invalid sample width */
  345.     AF_ERR_BAD_SEEKMODE = 18+AF_ERR_BASE,    /* invalid seek mode */
  346.     AF_ERR_BAD_LOOPID = 21+AF_ERR_BASE,    /* invalid loop id */
  347.     AF_ERR_BAD_SAMPFMT = 22+AF_ERR_BASE,    /* bad sample format */
  348.     AF_ERR_BAD_FILESETUP = 23+AF_ERR_BASE,    /* bad file setup structure*/
  349.     AF_ERR_BAD_TRACKID = 24+AF_ERR_BASE,    /* no track corresponding to id */
  350.     AF_ERR_BAD_NUMTRACKS = 25+AF_ERR_BASE,    /* wrong number of tracks for file format */
  351.     AF_ERR_BAD_LOOPMODE = 27+AF_ERR_BASE,    /* unrecognized loop mode symbol */
  352.     AF_ERR_BAD_INSTID = 28+AF_ERR_BASE,    /* invalid instrument id */
  353.     AF_ERR_BAD_NUMLOOPS = 29+AF_ERR_BASE,    /* bad number of loops */
  354.     AF_ERR_BAD_NUMMARKS = 30+AF_ERR_BASE,    /* bad number of markers */
  355.     AF_ERR_BAD_MARKID = 31+AF_ERR_BASE,    /* bad marker id */
  356.     AF_ERR_BAD_MARKPOS = 32+AF_ERR_BASE,    /* invalid marker position value */
  357.     AF_ERR_BAD_NUMINSTS = 33+AF_ERR_BASE,    /* invalid number of instruments */
  358.     AF_ERR_BAD_NOAESDATA = 34+AF_ERR_BASE,
  359.     AF_ERR_BAD_MISCID = 35+AF_ERR_BASE,
  360.     AF_ERR_BAD_NUMMISC = 36+AF_ERR_BASE,
  361.     AF_ERR_BAD_MISCSIZE = 37+AF_ERR_BASE,
  362.     AF_ERR_BAD_MISCTYPE = 38+AF_ERR_BASE,
  363.     AF_ERR_BAD_MISCSEEK = 39+AF_ERR_BASE,
  364.     AF_ERR_BAD_STRLEN = 40+AF_ERR_BASE,    /* invalid string length */
  365.     AF_ERR_BAD_RATECONV = 45+AF_ERR_BASE,
  366.     AF_ERR_BAD_SYNCFILE = 46+AF_ERR_BASE,
  367.     AF_ERR_BAD_CODEC_CONFIG = 47+AF_ERR_BASE,    /* improperly configured codec */
  368.     AF_ERR_BAD_CODEC_TYPE = 50+AF_ERR_BASE,    /* unsupported codec type */
  369.     AF_ERR_BAD_INSTPTYPE = 51+AF_ERR_BASE,    /* invalid instrument parameter type */
  370.     AF_ERR_BAD_INSTPID = 52+AF_ERR_BASE,    /* invalid instrument parameter id */
  371.  
  372.     AF_ERR_BAD_BYTEORDER = 53+AF_ERR_BASE,
  373.     AF_ERR_BAD_FILEFMT_PARAM = 54+AF_ERR_BASE,    /* unrecognized file format parameter */
  374.     AF_ERR_BAD_COMP_PARAM = 55+AF_ERR_BASE,    /* unrecognized compression parameter */
  375.     AF_ERR_BAD_DATAOFFSET = 56+AF_ERR_BASE,    /* bad data offset */
  376.     AF_ERR_BAD_FRAMECNT = 57+AF_ERR_BASE,    /* bad frame count */
  377.  
  378.     AF_ERR_BAD_QUERYTYPE = 58+AF_ERR_BASE,    /* bad query type */
  379.     AF_ERR_BAD_QUERY = 59+AF_ERR_BASE,    /* bad argument to afQuery() */
  380.     AF_ERR_BAD_HEADER = 62+AF_ERR_BASE,    /* failed to parse header */
  381.     AF_ERR_BAD_FRAME = 63+AF_ERR_BASE,    /* bad frame number */
  382.     AF_ERR_BAD_LOOPCOUNT = 64+AF_ERR_BASE,    /* bad loop count */
  383.  
  384.     /* AIFF/AIFF-C specific errors when parsing file header */
  385.  
  386.     AF_ERR_BAD_AIFF_HEADER = 66+AF_ERR_BASE,    /* failed to parse chunk header */
  387.     AF_ERR_BAD_AIFF_FORM = 67+AF_ERR_BASE,    /* failed to parse FORM chunk */
  388.     AF_ERR_BAD_AIFF_SSND = 68+AF_ERR_BASE,    /* failed to parse SSND chunk */
  389.     AF_ERR_BAD_AIFF_CHUNKID = 69+AF_ERR_BASE,    /* unrecognized AIFF/AIFF-C chunk id */
  390.     AF_ERR_BAD_AIFF_COMM = 70+AF_ERR_BASE,    /* failed to parse COMM chunk */
  391.     AF_ERR_BAD_AIFF_INST = 71+AF_ERR_BASE,    /* failed to parse INST chunk */
  392.     AF_ERR_BAD_AIFF_MARK = 72+AF_ERR_BASE,    /* failed to parse MARK chunk */
  393.     AF_ERR_BAD_AIFF_SKIP = 73+AF_ERR_BASE,    /* failed to skip unsupported chunk */
  394.     AF_ERR_BAD_AIFF_LOOPMODE = 74+AF_ERR_BASE    /* unrecognized loop mode (forw, etc) */
  395. };
  396.  
  397.  
  398. /* global routines */
  399. AFerrfunc afSetErrorHandler (AFerrfunc efunc);
  400.  
  401. /* query routines */
  402. AUpvlist afQuery (int querytype, int arg1, int arg2, int arg3, int arg4);
  403. long afQueryLong (int querytype, int arg1, int arg2, int arg3, int arg4);
  404. double afQueryDouble (int querytype, int arg1, int arg2, int arg3, int arg4);
  405. void *afQueryPointer (int querytype, int arg1, int arg2, int arg3, int arg4);
  406.  
  407. /* basic operations on file handles and file setups */
  408. AFfilesetup afNewFileSetup (void);
  409. void afFreeFileSetup (AFfilesetup);
  410. int afIdentifyFD (int);
  411. int afIdentifyNamedFD (int, const char *filename, int *implemented);
  412.  
  413. AFfilehandle afOpenFile (const char *filename, const char *mode,
  414.     AFfilesetup setup);
  415. AFfilehandle afOpenFD (int fd, const char *mode, AFfilesetup setup);
  416. AFfilehandle afOpenNamedFD (int fd, const char *mode, AFfilesetup setup,
  417.     const char *filename);
  418.  
  419. int afGetFD (AFfilehandle file);
  420. void afSaveFilePosition (AFfilehandle file);
  421. void afRestoreFilePosition (AFfilehandle file);
  422. int afSyncFile (AFfilehandle file);
  423. int afCloseFile (AFfilehandle file);
  424.  
  425. void afInitFileFormat (AFfilesetup, int format);
  426. int afGetFileFormat (AFfilehandle, int *version);
  427.  
  428. /* track */
  429. void afInitTrackIDs (AFfilesetup, int *trackids, int trackCount);
  430. int afGetTrackIDs (AFfilehandle, int *trackids);
  431.  
  432. /* track data: reading, writng, seeking, sizing frames */
  433. int afReadFrames (AFfilehandle, int track, void *buffer, int frameCount);
  434. int afWriteFrames (AFfilehandle, int track, void *buffer, int frameCount);
  435. AFframecount afSeekFrame (AFfilehandle, int track, AFframecount frameoffset);
  436. AFfileoffset afTellFrame (AFfilehandle, int track);
  437. AFfileoffset afGetTrackBytes (AFfilehandle, int track);
  438. float afGetFrameSize (AFfilehandle, int track, int expand3to4);
  439. #if 0
  440. float afGetVirtualFrameSize (AFfilehandle, int track, int expand3to4);
  441. #endif
  442.  
  443. /* track data: AES data */
  444. /* afInitAESChannelData is obsolete -- use afInitAESChannelDataTo() */
  445. void afInitAESChannelData (AFfilesetup, int track); /* obsolete */
  446. void afInitAESChannelDataTo (AFfilesetup, int track, int willBeData);
  447. int afGetAESChannelData (AFfilehandle, int track, unsigned char buf[24]);
  448. void afSetAESChannelData (AFfilehandle, int track, unsigned char buf[24]);
  449.  
  450. #if 0
  451. /* track setup format initialized via DMparams */
  452. /* track format retrieved via DMparams */
  453. DMstatus afInitFormatParams (AFfilesetup, int track, DMparams *params);
  454. /* virtual format set via DMparams */
  455. DMstatus afGetFormatParams (AFfilehandle, int track, DMparams *params);
  456. /* virtual format retrieved via DMparams */
  457. DMstatus afSetVirtualFormatParams (AFfilehandle, int track, DMparams *params);
  458. DMstatus afGetVirtualFormatParams (AFfilehandle, int track, DMparams *params);
  459. /* conversion/compression params set via DMparams */
  460. DMstatus afSetConversionParams (AFfilehandle, int track, DMparams *params);
  461. /* conversion/compression params retrieved via DMparams */
  462. DMstatus afGetConversionParams (AFfilehandle, int track, DMparams *params);
  463. #endif
  464.  
  465. /* track data: byte order */
  466. void afInitByteOrder (AFfilesetup, int track, int byteOrder);
  467. int afGetByteOrder (AFfilehandle, int track);
  468. int afSetVirtualByteOrder (AFfilehandle, int track, int byteOrder);
  469. int afGetVirtualByteOrder (AFfilehandle, int track);
  470.  
  471. /* track data: number of channels */
  472. void afInitChannels (AFfilesetup, int track, int nchannels);
  473. int afGetChannels (AFfilehandle, int track);
  474. int afSetVirtualChannels (AFfilehandle, int track, int channelCount);
  475. int afGetVirtualChannels (AFfilehandle, int track);
  476. void afSetChannelMatrix (AFfilehandle, int track, double *matrix);
  477.  
  478. /* track data: sample format and sample width */
  479. void afInitSampleFormat (AFfilesetup, int track, int sampleFormat,
  480.     int sampleWidth);
  481. void afGetSampleFormat (AFfilehandle file, int track, int *sampfmt,
  482.     int *sampwidth);
  483. void afGetVirtualSampleFormat (AFfilehandle file, int track, int *sampfmt,
  484.     int *sampwidth);
  485. #if 0
  486. int afSetVirtualSampleFormat (AFfilehandle, int track,
  487.     int sampleFormat, int sampleWidth);
  488. void afGetVirtualSampleFormat (AFfilehandle, int track,
  489.     int *sampleFormat, int *sampleWidth);
  490. #endif
  491.  
  492. /* track data: sampling rate */
  493. void afInitRate (AFfilesetup, int track, double rate);
  494. double afGetRate (AFfilehandle, int track);
  495.  
  496. #if 0
  497. int afSetVirtualRate (AFfilehandle, int track, double rate);
  498. double afGetVirtualRate (AFfilehandle, int track);
  499. #endif
  500.  
  501. /* track data: compression */
  502. void afInitCompression (AFfilesetup, int track, int compression);
  503. #if 0
  504. void afInitCompressionParams (AFfilesetup, int track, int compression
  505.     AUpvlist params, int parameterCount);
  506. #endif
  507.  
  508. int afGetCompression (AFfilehandle, int track);
  509. #if 0
  510. void afGetCompressionParams (AFfilehandle, int track, int *compression,
  511.     AUpvlist params, int parameterCount);
  512.  
  513. int afSetVirtualCompression (AFfilesetup, int track, int compression);
  514. void afSetVirtualCompressionParams (AFfilehandle, int track, int compression,
  515.     AUpvlist params, int parameterCount);
  516.  
  517. int afGetVirtualCompression (AFfilesetup, int track, int compression);
  518. void afGetVirtualCompressionParams (AFfilehandle, int track, int *compression,
  519.     AUpvlist params, int parameterCount);
  520. #endif
  521.  
  522. #if 0
  523. /* track data: pcm mapping */
  524. void afInitPCMMapping (AFfilesetup filesetup, int track,
  525.     double slope, double intercept, double minClip, double maxClip);
  526. void afGetPCMMapping (AFfilehandle file, int track,
  527.     double *slope, double *intercept, double *minClip, double *maxClip);
  528. /* NOTE: afSetTrackPCMMapping() is special--it does not set the virtual  */
  529. /* format; it changes what the AF thinks the track format is! Be careful. */
  530. int afSetTrackPCMMapping (AFfilehandle file, int track,
  531.     double slope, double intercept, double minClip, double maxClip);
  532. /* NOTE: afSetVirtualPCMMapping() is different from afSetTrackPCMMapping(): */
  533. /* see comment for afSetTrackPCMMapping(). */
  534. int afSetVirtualPCMMapping (AFfilehandle file, int track,
  535.     double slope, double intercept, double minClip, double maxClip);
  536. void afGetVirtualPCMMapping (AFfilehandle file, int track,
  537.     double *slope, double *intercept, double *minClip, double *maxClip);
  538.  
  539. #endif
  540.  
  541. /* track data: data offset within the file */
  542. /* initialize for raw reading only */
  543. void afInitDataOffset(AFfilesetup, int track, AFfileoffset offset);
  544. AFfileoffset afGetDataOffset (AFfilehandle, int track);
  545.  
  546. /* track data: count of frames in file */
  547. void afInitFrameCount (AFfilesetup, int track, AFframecount frameCount);
  548. AFframecount afGetFrameCount (AFfilehandle file, int track);
  549.  
  550. /* loop operations */
  551. void afInitLoopIDs (AFfilesetup, int instid, int ids[], int nids);
  552. int afGetLoopIDs (AFfilehandle, int instid, int loopids[]);
  553. void afSetLoopMode (AFfilehandle, int instid, int loop, int mode);
  554. int afGetLoopMode (AFfilehandle, int instid, int loopid);
  555. int afSetLoopCount (AFfilehandle, int instid, int loop, int count);
  556. int afGetLoopCount (AFfilehandle, int instid, int loopid);
  557. void afSetLoopStart (AFfilehandle, int instid, int loopid, int markerid);
  558. int afGetLoopStart (AFfilehandle, int instid, int loopid);
  559. void afSetLoopEnd (AFfilehandle, int instid, int loopid, int markerid);
  560. int afGetLoopEnd (AFfilehandle, int instid, int loopid);
  561.  
  562. int afSetLoopStartFrame (AFfilehandle, int instid, int loop,
  563.     AFframecount startFrame);
  564. AFframecount afGetLoopStartFrame (AFfilehandle, int instid, int loop);
  565. int afSetLoopEndFrame (AFfilehandle, int instid, int loop,
  566.     AFframecount startFrame);
  567. AFframecount afGetLoopEndFrame (AFfilehandle, int instid, int loop);
  568.  
  569. void afSetLoopTrack (AFfilehandle, int instid, int loopid, int trackid);
  570. int afGetLoopTrack (AFfilehandle, int instid, int loopid);
  571.  
  572. /* marker operations */
  573. void afInitMarkIDs (AFfilesetup, int trackid, int *ids, int nids);
  574. int afGetMarkIDs (AFfilehandle file, int trackid, int markids[]);
  575. void afSetMarkPosition (AFfilehandle file, int trackid, int markid,
  576.     AFframecount markpos);
  577. AFframecount afGetMarkPosition (AFfilehandle file, int trackid, int markid);
  578. void afInitMarkName (AFfilesetup, int trackid, int marker, const char *name);
  579. void afInitMarkComment (AFfilesetup, int trackid, int marker,
  580.     const char *comment);
  581. char *afGetMarkName (AFfilehandle file, int trackid, int markid);
  582. char *afGetMarkComment (AFfilehandle file, int trackid, int markid);
  583.  
  584. /* instrument operations */
  585. void afInitInstIDs (AFfilesetup, int *ids, int nids);
  586. int afGetInstIDs (AFfilehandle file, int *instids);
  587. void afGetInstParams (AFfilehandle file, int instid, AUpvlist pvlist,
  588.     int nparams);
  589. void afSetInstParams (AFfilehandle file, int instid, AUpvlist pvlist,
  590.     int nparams);
  591. long afGetInstParamLong (AFfilehandle file, int instid, int param);
  592. void afSetInstParamLong (AFfilehandle file, int instid, int param, long value);
  593.  
  594. /* miscellaneous data operations */
  595. void afInitMiscIDs (AFfilesetup, int *ids, int nids);
  596. int afGetMiscIDs (AFfilehandle, int *ids);
  597. void afInitMiscType (AFfilesetup, int miscellaneousid, int type);
  598. int afGetMiscType (AFfilehandle, int miscellaneousid);
  599. void afInitMiscSize (AFfilesetup, int miscellaneousid, int size);
  600. int afGetMiscSize (AFfilehandle, int miscellaneousid);
  601. int afWriteMisc (AFfilehandle, int miscellaneousid, void *buf, int bytes);
  602. int afReadMisc (AFfilehandle, int miscellaneousid, void *buf, int bytes);
  603. int afSeekMisc (AFfilehandle, int miscellaneousid, int offset);
  604.  
  605. #ifdef __cplusplus
  606. }
  607. #endif /* __cplusplus */
  608.  
  609. #endif /* AUDIOFILE_H */
  610.